consolidate EC2 installation info #2177

alexakreizinger · 2025-11-17T20:02:06Z

this PR consolidates the EC2 installation info into the general amazon linux doc (since the original EC2 page was basically a stub). additionally, I reformatted a few things in the amazon linux doc to better accommodate the newly-moved info.

Summary by CodeRabbit

Documentation
- Consolidated Amazon EC2 installation documentation into the main Amazon Linux installation guide with tabbed support for Amazon Linux 2 and 2023 versions.
- Enhanced installation flow with improved formatting, hint blocks for configuration steps, and reorganized step numbering.
Refactor
- Restructured installation documentation to consolidate related content and improve maintainability.

Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>

coderabbitai · 2025-11-17T20:02:18Z

Walkthrough

This change consolidates Amazon EC2 installation documentation by migrating the separate amazon-ec2.md file into an "Install on Amazon EC2" subsection within amazon-linux.md, updating GitBook redirects accordingly, and removing the old entry from SUMMARY.md while improving documentation structure with tabs and formatting enhancements.

Changes

Cohort / File(s)	Summary
Configuration and redirects `.gitbook.yaml`	Updated redirect for `about/sandbox-and-lab-resources` from absolute (`/about/resources.md`) to relative path (`./about/resources.md`); added new redirect mapping `installation/downloads/amazon-ec2` to `./installation/downloads/linux/amazon-linux.md`
Table of contents `SUMMARY.md`	Removed Amazon EC2 entry from Linux packages subsection under Installation
Documentation consolidation `installation/downloads/amazon-ec2.md`	File deleted
Consolidated documentation `installation/downloads/linux/amazon-linux.md`	Added new "Install on Amazon EC2" subsection; introduced tabbed content structure for Amazon Linux 2 vs. 2023; added markdownlint comments and info/hint blocks around repository configuration and GPG key instructions; updated wording to generalize from "latest" versions; reworked command step numbering

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Verify the GitBook redirect for amazon-ec2 correctly resolves to the new location in amazon-linux.md
Confirm all content from the original amazon-ec2.md is preserved in the new subsection
Review the tabbed structure for Amazon Linux 2 vs. 2023 for completeness and accuracy
Ensure SUMMARY.md removal aligns with the file consolidation

Possibly related PRs

#2172: Both PRs modify installation documentation and .gitbook.yaml redirects, with related consolidation and redirect management strategies.

Suggested reviewers

gguillotte

Poem

🐰 Files hop together, consolidate with care,
Amazon EC2 finds its home elsewhere,
Redirects guide the path so true,
Documentation flows fresh and new! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'consolidate EC2 installation info' accurately reflects the main objective of this PR, which consolidates EC2 installation information into the Amazon Linux documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch alexakreizinger/sc-154735/consolidate-amazon-ec2-install-info

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c448901 and 577b62e.

📒 Files selected for processing (4)

.gitbook.yaml (1 hunks)
SUMMARY.md (0 hunks)
installation/downloads/amazon-ec2.md (0 hunks)
installation/downloads/linux/amazon-linux.md (4 hunks)

💤 Files with no reviewable changes (2)

installation/downloads/amazon-ec2.md
SUMMARY.md

🔇 Additional comments (6)

.gitbook.yaml (1)

101-102: Redirect configuration aligns with consolidation.

The redirect on line 102 properly routes the old EC2 installation page to the consolidated Amazon Linux documentation. The path style change on line 101 (absolute to relative) is a minor consistency improvement.

However, verify that the GitBook redirect lands users at the correct section. GitBook redirects typically load the target document root; users may not automatically scroll to the "Install on Amazon EC2" subsection (line 8 in amazon-linux.md). Consider whether a fragment anchor in the redirect (e.g., #install-on-amazon-ec2) would improve UX, though GitBook's default redirect behavior may not support this.

installation/downloads/linux/amazon-linux.md (5)

1-6: Intro section is clear and accurate.

The updated introductory text correctly establishes support for both Amazon Linux 2 and 2023 with supported architectures clearly listed.

8-10: EC2 subsection appropriately references external AWS guide.

The section correctly directs EC2 users to the AWS-maintained Systems Manager guide. Note that the guide is specified for Amazon Linux 2 only; if Amazon Linux 2023 EC2 support is available through AWS Systems Manager, consider clarifying or adding a note.

Verify whether AWS Systems Manager EC2 installation support exists for Amazon Linux 2023, and whether users should have guidance for that platform.

12-14: Section structure effectively separates EC2 and general installation paths.

The "General installation" heading and intro text clearly distinguish this from the EC2-specific subsection above, providing good navigation for users.

16-82: Installation steps are well-structured with appropriate tabbing and formatting.

The use of tabs to distinguish Amazon Linux 2 and 2023 repository configurations is clean and maintainable. The markdownlint-disable comment appropriately handles the necessary exception for hard-coded step numbers. Repository URLs, GPG configuration, and service commands are correct.

Verify that the relative path reference on line 53 (../linux.md#gpg-key-updates) is correct. Given that this file is located at installation/downloads/linux/amazon-linux.md, the path should point to a sibling linux.md in the same directory. Confirm the intended target file location and verify the path syntax is accurate.

3-10: Documentation accurately reflects different support levels across installation methods.

The document clearly distinguishes between EC2-specific installation (Amazon Linux 2 via AWS Systems Manager) and general installation (both Amazon Linux 2 and 2023). This is a reasonable split, as AWS-specific tooling may have different availability than general package repositories. Users redirected from the old amazon-ec2.md page will now see both options.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>

alexakreizinger · 2025-11-17T20:05:39Z

installation/downloads/linux/amazon-linux.md

+To install Fluent Bit on any Amazon Linux instance, follow these steps.

-## Configure YUM
+<!-- markdownlint-disable MD029 -->


I wasn't sure if the tabs/hint in the middle of these steps would break GitBook's auto-numbering for procedures, and apparently it does, so I'm glad I checked :P adding a markdownlint flag here so I can make an exception to use hard-coded step numbers

eschabell · 2025-11-18T14:53:57Z

Merging!

consolidate EC2 installation info

c5f2105

Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>

alexakreizinger requested review from a team as code owners November 17, 2025 20:02

fix numbering(?)

577b62e

Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>

alexakreizinger commented Nov 17, 2025

View reviewed changes

cosmo0920 approved these changes Nov 18, 2025

View reviewed changes

eschabell self-assigned this Nov 18, 2025

eschabell merged commit 6b362ea into master Nov 18, 2025
8 checks passed

eschabell deleted the alexakreizinger/sc-154735/consolidate-amazon-ec2-install-info branch November 18, 2025 14:54

eschabell mentioned this pull request Nov 18, 2025

Missing systems-manager-ec2 file on fluent bit docs site #2179

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

consolidate EC2 installation info #2177

consolidate EC2 installation info #2177

alexakreizinger commented Nov 17, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 17, 2025 •

edited

Loading

Uh oh!

alexakreizinger Nov 17, 2025

Uh oh!

eschabell commented Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

consolidate EC2 installation info #2177

consolidate EC2 installation info #2177

Conversation

alexakreizinger commented Nov 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

alexakreizinger Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

eschabell commented Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alexakreizinger commented Nov 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 17, 2025 •

edited

Loading